Skip to content

Conversation

@Cloxl
Copy link
Owner

@Cloxl Cloxl commented Jan 15, 2026

Summary by Sourcery

添加结构化的 GitHub Issue 模板,并调整发布工作流中变更日志输出的标记。

New Features:

  • 引入用于 API 提案、错误报告、功能请求和一般讨论的 GitHub Issue 模板,以规范社区贡献。

Enhancements:

  • 配置 GitHub Issue 模板设置,禁用空白 Issue,并为一般问题提供前往 Discussions 和文档的链接。
  • 更新发布工作流中变更日志 heredoc 标记,以避免冲突并确保正确生成变更日志。
Original summary in English

Summary by Sourcery

Add structured GitHub issue templates and adjust the release workflow changelog output marker.

New Features:

  • Introduce GitHub issue templates for API proposals, bug reports, feature requests, and general discussions to standardize community contributions.

Enhancements:

  • Configure GitHub issue template settings to disable blank issues and surface links to Discussions and documentation for general questions.
  • Update the release workflow changelog heredoc marker to avoid conflicts and ensure correct changelog generation.

Cloxl added 5 commits January 15, 2026 19:01
- Add English and Chinese issue templates
- Bug Report templates (bug_report.yml, bug_report_cn.yml)
- Feature Request templates (feature_request.yml, feature_request_cn.yml)
- API Proposal templates (api_proposal.yml, api_proposal_cn.yml)
- Configure template settings in config.yml
- Separate templates by language for better UX
- All templates include structured forms with validation
- API Proposal template designed for issue #60 discussion
- Change EOF to CHANGELOG_EOF as heredoc delimiter
- Prevent commit messages containing 'EOF' from breaking changelog generation
- Improve robustness of release notes generation
Resolve conflict in release.yml by keeping CHANGELOG_EOF delimiter
…discussion option

- Replace 6 separate templates (3 EN + 3 CN) with 4 bilingual templates
- Add General Discussion template as fallback option
- All templates now use bilingual format (中文 | English)
- Simplify user experience: 6 options → 4 options
- Templates:
  1. Bug 报告 | Bug Report
  2. 功能请求 | Feature Request
  3. API 语法糖提案 | API Proposal
  4. 通用讨论 | General Discussion (new)
- Update config.yml with simplified contact links
- Maintain blank_issues_enabled: false for structured contributions
@sourcery-ai
Copy link

sourcery-ai bot commented Jan 15, 2026

Reviewer's Guide

添加了结构化的 GitHub Issue 模板(API 提案、错误报告、功能需求、一般讨论),并配置了 Issue 处理方式,同时修复了发布工作流中 changelog 输出分隔符的一个小问题。

用于生成发布工作流 changelog 输出的流程图

flowchart TD
  A[release_workflow_job] --> B[Checkout_repository]
  B --> C[Determine_PREV_TAG]
  C --> D{PREV_TAG_exists}

  D -->|Yes| E[Append_Whats_Changed_section_to_GITHUB_OUTPUT]
  D -->|No| F[Append_Initial_release_to_GITHUB_OUTPUT]

  E --> G[Wrap_content_with_CHANGELOG_EOF_delimiter]
  F --> G

  G --> H[Set_CHANGELOG_output_variable]
  H --> I[Set_VERSION_NO_V_output_variable]
Loading

File-Level Changes

Change Details Files
调整发布工作流中的 changelog 输出分隔符,避免与内容中可能出现的 EOF 标记冲突。
  • 在将 CHANGELOG 变量写入 GITHUB_OUTPUT 时,将类似 heredoc 的标记从 EOF 更改为 CHANGELOG_EOF
  • 确保开头和结尾标记都使用相同的新标识符
.github/workflows/release.yml
引入结构化 API 提案 Issue 模板,以规范新的语法糖 API 设计讨论。
  • 添加 API 名称、类型、动机、用例、当前用法 vs 提议用法以及函数签名等中英双语字段
  • 要求明确描述收益以及向后兼容性保证
  • 提供替代设计和额外背景的章节,以鼓励更深入的提案
.github/ISSUE_TEMPLATE/api_proposal.yml
添加错误报告模板,以收集问题所需的所有诊断信息。
  • 结构化收集描述、复现步骤、预期行为 vs 实际行为以及最小代码示例等信息
  • 包含可选的 traceback 字段,以及必填的环境信息(xhshow 版本、Python 版本、操作系统)
  • 提供额外上下文字段,用于填写其他补充细节
.github/ISSUE_TEMPLATE/bug_report.yml
添加功能请求模板,引导用户描述新功能和兼容性方面的考虑。
  • 要求提供问题陈述、拟议解决方案、具体使用示例,以及已考虑的替代方案
  • 要求明确说明该功能是否为破坏性变更,并可选提供兼容性确认
  • 提供额外上下文章节,用于附加更多资料
.github/ISSUE_TEMPLATE/feature_request.yml
添加一般讨论 Issue 模板,并配置 Issue 路由以及讨论与文档的外部链接。
  • 引入一个通用模板,用于提问和讨论,包含描述、上下文和附加信息字段
  • 完全禁用空白 Issue,鼓励使用模板或讨论链接
  • 添加 GitHub Discussions 和项目文档的联系链接,用于非 Issue 类型的咨询
.github/ISSUE_TEMPLATE/general.yml
.github/ISSUE_TEMPLATE/config.yml

Tips and commands

Interacting with Sourcery

  • 触发新的代码审查: 在 Pull Request 中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 从审查评论生成 GitHub Issue: 在审查评论下回复,请 Sourcery 根据该评论创建 Issue。你也可以直接回复 @sourcery-ai issue 来从该评论创建 Issue。
  • 生成 Pull Request 标题: 在 Pull Request 标题的任意位置写上 @sourcery-ai,即可随时生成标题。你也可以在 Pull Request 中评论 @sourcery-ai title 来(重新)生成标题。
  • 生成 Pull Request 总结: 在 Pull Request 正文任意位置写上 @sourcery-ai summary,即可在该位置生成 PR 总结。你也可以在 Pull Request 中评论 @sourcery-ai summary 来随时(重新)生成总结。
  • 生成 Reviewer's Guide: 在 Pull Request 中评论 @sourcery-ai guide,即可随时(重新)生成 Reviewer's Guide。
  • 一次性解决所有 Sourcery 评论: 在 Pull Request 中评论 @sourcery-ai resolve,即可将所有 Sourcery 评论标记为已解决。适用于你已经处理完所有评论且不希望再看到它们的情况。
  • 一次性撤销所有 Sourcery Review: 在 Pull Request 中评论 @sourcery-ai dismiss,即可撤销所有现有的 Sourcery Review。特别适用于你想从头开始新的审查时——别忘了再评论 @sourcery-ai review 以触发新的审查!

Customizing Your Experience

访问你的 dashboard 以:

  • 启用或禁用诸如 Sourcery 生成的 Pull Request 总结、Reviewer's Guide 等审查功能。
  • 更改审查语言。
  • 添加、删除或编辑自定义审查指令。
  • 调整其他审查设置。

Getting Help

Original review guide in English

Reviewer's Guide

Adds structured GitHub issue templates (API proposal, bug report, feature request, general discussion) and configures issue handling, plus a small fix to the release workflow changelog output delimiter.

Flow diagram for release workflow changelog output generation

flowchart TD
  A[release_workflow_job] --> B[Checkout_repository]
  B --> C[Determine_PREV_TAG]
  C --> D{PREV_TAG_exists}

  D -->|Yes| E[Append_Whats_Changed_section_to_GITHUB_OUTPUT]
  D -->|No| F[Append_Initial_release_to_GITHUB_OUTPUT]

  E --> G[Wrap_content_with_CHANGELOG_EOF_delimiter]
  F --> G

  G --> H[Set_CHANGELOG_output_variable]
  H --> I[Set_VERSION_NO_V_output_variable]
Loading

File-Level Changes

Change Details Files
Adjust changelog output delimiter in the release workflow to avoid conflicting with potential EOF markers in content.
  • Change the heredoc-like marker from EOF to CHANGELOG_EOF when writing the CHANGELOG variable to GITHUB_OUTPUT
  • Ensure both the opening and closing markers use the same new identifier
.github/workflows/release.yml
Introduce a structured API proposal issue template to standardize new syntax-sugar API design discussions.
  • Add bilingual (Chinese/English) fields for API name, type, motivation, use cases, current vs proposed usage, and signature
  • Require explicit description of benefits and backward compatibility guarantees
  • Provide sections for alternative designs and additional context to encourage thoughtful proposals
.github/ISSUE_TEMPLATE/api_proposal.yml
Add a bug report template to collect all necessary diagnostic information for issues.
  • Collect structured information about description, reproduction steps, expected vs actual behavior, and minimal code sample
  • Include optional traceback field and required environment info (xhshow version, Python version, OS)
  • Provide additional context field for any extra details
.github/ISSUE_TEMPLATE/bug_report.yml
Add a feature request template to guide users through describing new features and compatibility considerations.
  • Ask for problem statement, proposed solution, concrete usage example, and alternatives considered
  • Require explicit indication whether the feature is breaking, and optional compatibility confirmations
  • Provide an additional context section for extra materials
.github/ISSUE_TEMPLATE/feature_request.yml
Add a general discussion issue template and configure issue routing and external links for discussions and docs.
  • Introduce a general-purpose template for questions and discussions with description, context, and additional information fields
  • Disable completely blank issues to encourage use of templates or discussion links
  • Add contact links to GitHub Discussions and project documentation for non-issue queries
.github/ISSUE_TEMPLATE/general.yml
.github/ISSUE_TEMPLATE/config.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - 我已经审阅了你的更改,一切看起来很棒!


Sourcery 对开源项目是免费的——如果你喜欢我们的代码审查,请考虑分享给更多人 ✨
帮我变得更有用吧!请对每条评论点 👍 或 👎,我会根据你的反馈改进之后的代码审查。
Original comment in English

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

- Resolve conflicts by keeping local bilingual templates
- Maintain 4-template structure (Bug/Feature/API/General)
- Remove redundant *_cn.yml files from master
@Cloxl Cloxl merged commit 7f01cc5 into master Jan 15, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants